Scrolling Waveforms blog post #314

m0dB · 2024-01-21T21:49:27Z

https://deploy-preview-314--mixxx-website.netlify.app/news/2023-08-15-improved-waveforms/

wip wip

Holzhaus · 2024-01-21T22:06:15Z

Hi Maarten, have you considered to add some author metadata to the config file? This will make it possible to add a tagline and associate your name with your GitHub user.

It works like this: https://github.com/mixxxdj/website/blob/website/pelicanconf.py#L190-L195

ronso0

Thank you, this is very easy to read.

Just some minor remarks.

It's a lot of text, have you considered adding some footage?

content/news/2024-01-23-improved-waveforms.md

Co-authored-by: ronso0 <[email protected]>

JoergAtGithub · 2024-01-25T19:49:26Z

content/news/2024-01-23-improved-waveforms.md

+
+The Mixxx scrolling waveforms are drawn with a number of overlapping layers: The beat grid, the looping-, intro- and outro-ranges, the markers, the end-of-track indication, and the actual waveform. Originally these layers were rendered with a combination of Qt (QPainter) and Legacy OpenGL calls, on the now deprecated QGLWidget. Profiling showed that this combination was a performance bottleneck, particularly on macOS. With the rewrite, all these layers are now using Modern OpenGL, with hardware accelerated GLSL shaders. The different waveform types (Simple, Filtered, HSV, RGB and RGB L/R) all come with a GLSL implementation. In addition to the waveforms, the spinny widgets and VU-meters have been rewritten with the same approach.
+
+Visually the new waveforms follow the design of the legacy waveforms, with some minor tweaks, note for example the semi-transparently filled triangles pre- and post track. What has been improved is the layout of the markers layers: Overlapping markers (multiple markers at the same beat grid location) which would previously obfuscate each other, are now automatically placed at an increasing / decreasing vertical position.


The writting is really good, but I would recommend to insert two detail screenshots showing:

the pre-track triangles

the stacked markers

The beatgrid in the triangle screenshot has an offset. Could you adjust this?

I replaced it with a different screenshot. Is this better?

Swiftb0y · 2024-01-26T00:34:42Z

right now this is quite a lot of text. I think a little sign-posting in the form of subheadings would not also make the text look nicer but also easier to read/navigate.

content/news/2024-01-23-improved-waveforms.md

Co-authored-by: ronso0 <[email protected]>

…eenshots

m0dB · 2024-01-27T16:58:29Z

I have made the changes suggested here, as well as some restructuring suggested by @ywwg , starting with less technical talk for normal users and moving the technical details to the end.

JoergAtGithub

I think we ca publish it, as it is! Thank you!

m0dB · 2024-01-27T20:32:20Z

great! i'd appreciate a last review from a native speaker (@ywwg maybe?).

JoergAtGithub · 2024-01-28T04:43:51Z

@m0dB There` is a review of a native speaker on Zulip https://mixxx.zulipchat.com/#narrow/stream/248802-website/topic/Native.20Englisch.20speaker.20needed.2C.20to.20check.20blog.20post

…2-website/topic/Native.20Englisch.20speaker.20needed.2C.20to.20check.20blog.20post/near/418462984 and for PLL being default on macOS

m0dB · 2024-01-30T17:18:29Z

I think this is ready for publication. What do you think is the best time to do that? Immediately / shortly after the 2.4 release announcement?

ywwg · 2024-02-13T13:58:05Z

I don't suppose we can do scheduled posts? :). Let's not forget about this

Swiftb0y · 2024-02-13T15:40:05Z

I think if this ready now, why not publish now as a teaser for the upcoming 2.4 release?

m0dB · 2024-02-13T18:57:12Z

Yes, this is ready. I think posting now as a "teaser" is fine, as long as 2.4 is truly about to be released 😅

Swiftb0y · 2024-02-13T19:04:19Z

yeah, I'll leave that decision up to people more involved in the release process right now. @daschuer @ywwg @JoergAtGithub

m0dB · 2024-02-19T19:22:03Z

What do you think would be a good moment to publish this?

JoergAtGithub · 2024-02-19T19:29:45Z

If nobody objects, I will merge this tonight!

ronso0 · 2024-02-19T22:11:44Z

Though that's a rather short time to raise an objection.
I suggest to wait for at least a day, and also post it on the coreteam Zulip stream.

Don't wanna complciat things but if you mean it there should be a fair chance to catch this note in time.

daschuer

LGTM already.

If you wish the PLL section can be have some more details. See discussion in https://mixxx.zulipchat.com/#narrow/stream/247620-development-help/topic/vSync

PLL: no improvement for Linux/Windows
Not related to audio performance
Free = for debug only.

daschuer · 2024-02-20T06:42:57Z

content/news/2024-01-23-improved-waveforms.md

+
+## New display synchronization mode
+
+Finally, a last minute addition is an alternative mode to synchronise the scrolling waveform animation with the display refresh rate, using a so-called phase-locked-loop (PLL). This mechanism attempts to track the actual refresh rate and timing of the display automatically. On particular hardware, the default periodic timer-based approach can result in jitter and frame drops, and the PLL may give better results. The PLL has been made the default on macOS. See [instructions to change the V-Sync mode](https://github.com/mixxxdj/mixxx/wiki/Changing-the-VSync-Mode-for-Scrolling-Waveforms) if you want to try which mode works best for you.


Suggested change

Finally, a last minute addition is an alternative mode to synchronise the scrolling waveform animation with the display refresh rate, using a so-called phase-locked-loop (PLL). This mechanism attempts to track the actual refresh rate and timing of the display automatically. On particular hardware, the default periodic timer-based approach can result in jitter and frame drops, and the PLL may give better results. The PLL has been made the default on macOS. See [instructions to change the V-Sync mode](https://github.com/mixxxdj/mixxx/wiki/Changing-the-VSync-Mode-for-Scrolling-Waveforms) if you want to try which mode works best for you.

To avoid micro jitter, it is required to display the rendered picture in the right moment. This is achieved by synchronising the scrolling waveform animation with the display refresh rate. As a last minute addition an alternative mode to using a so-called phase-locked-loop (PLL) has been introduced. This mechanism attempts to track the actual refresh rate and timing of the display automatically. On particular hardware, the default periodic timer-based approach can result in jitter and frame drops, and the PLL may give better results. The PLL has been made the default on macOS other targets did not show an improvement. See [instructions to change the V-Sync mode](https://github.com/mixxxdj/mixxx/wiki/Changing-the-VSync-Mode-for-Scrolling-Waveforms) if you want to try which mode works best for you. This setting does not effect the audio control performance.

JoergAtGithub · 2024-02-20T06:43:21Z

OT: PLL shows also improvements on Windows, but does not work on every system - might be graphic driver related.

content/news/2024-01-23-improved-waveforms.md

ywwg · 2024-02-21T04:30:25Z

the only note I have is that the first heading is "REWRITE" and looks a bit weird on the news page:

maybe call that section "Starting From Scratch" ?

ywwg · 2024-02-21T04:47:58Z

or otherwise move the 'more...' break

ywwg · 2024-02-21T20:13:04Z

I'll merge this tomorrow so as not to double-up with the flatpak blog post

m0dB · 2024-02-22T20:42:39Z

or otherwise move the 'more...' break

Is that possible?

ronso0 · 2024-02-23T00:40:40Z

or otherwise move the 'more...' break

Is that possible?

I don't think so, not without hacking the news template or bending over otherwise.

I think the general issue is (for me) that first-level headings are too dominant, their font size is about twice as that of the paragraphs.
And here the first paragraph is short enough to make zhe the first heading appear in the preview.

No idea how to work around that.

m0dB · 2024-02-23T06:19:24Z

I'll make the first paragraph a bit longer!

JoergAtGithub · 2024-02-23T20:18:24Z

Let's merge this now! Thank you Marten!

Holzhaus · 2024-01-30T20:40:18Z

content/news/2024-01-23-improved-waveforms.md

+
+## Some technical insights
+
+Mixxx uses the Qt software framework for its user interface. Originally the layers that form the scrolling waveform display were rendered on the now deprecated QGLWidget through a combination of 'QPainter' and Legacy OpenGL function calls. Profiling showed that this combination was a performance bottleneck, particularly on macOS.


Suggested change

Mixxx uses the Qt software framework for its user interface. Originally the layers that form the scrolling waveform display were rendered on the now deprecated QGLWidget through a combination of 'QPainter' and Legacy OpenGL function calls. Profiling showed that this combination was a performance bottleneck, particularly on macOS.

Mixxx uses the Qt software framework for its user interface. Originally the layers that form the scrolling waveform display were rendered on the now deprecated `QGLWidget` through a combination of `QPainter` and legacy OpenGL function calls. Profiling showed that this combination was a performance bottleneck, particularly on macOS.

Holzhaus · 2024-01-30T20:41:12Z

content/news/2024-01-23-improved-waveforms.md

+
+With the rewrite, all the layers mentioned above are now implemented using Modern OpenGL code: All different waveform types, i.e, Simple, Filtered, HSV, RGB and RGB L/R, are now hardware accelarated using GLSL shaders. In addition to the waveforms, the spinny widgets and VU-meters code has been revised with the same approach.
+
+The deprecated QGLWidget has been replaced by a custom solution using a QOpenGLWindow inside a QWidget using the createWindowContainer() call. Qt also offers QOpenGLWidget to replace QGLWidget, but the QOpenGLWindow solution resulted in better performance and integrated better with the existing source code. This change will also facilitate the migration to Qt 6, planned for Mixxx 2.5.


Suggested change

The deprecated QGLWidget has been replaced by a custom solution using a QOpenGLWindow inside a QWidget using the createWindowContainer() call. Qt also offers QOpenGLWidget to replace QGLWidget, but the QOpenGLWindow solution resulted in better performance and integrated better with the existing source code. This change will also facilitate the migration to Qt 6, planned for Mixxx 2.5.

The deprecated `QGLWidget` has been replaced by a custom solution using a `QOpenGLWindow` inside a `QWidget` using the `createWindowContainer()` call. Qt also offers `QOpenGLWidget` to replace `QGLWidget`, but the `QOpenGLWindow` solution resulted in better performance and integrated better with the existing source code. This change will also facilitate the migration to Qt 6, planned for Mixxx 2.5.

Holzhaus · 2024-01-30T20:45:11Z

content/news/2024-01-23-improved-waveforms.md

+
+One of the major improvements of Mixxx 2.4 is a revision of the scrolling waveform implementation, to achieve smoother animation at a higher frame rate (60 fps), with less frame-drops and lower CPU load.
+
+## Rewrite


Not sure, do we really need this headline? It looks bad in the news section of the homepage.

I think we can either drop this headline, make the paragraph before the headline longer so that it gets pushed out of the excerpt or specify an excerpt explicitly in the metadata.

Holzhaus · 2024-02-24T00:00:13Z

Oops, forgot to submit my review. Sorry.

JoergAtGithub · 2024-02-24T10:19:59Z

The blogpost doen't appear on our website. Has anybody an idea why?

Swiftb0y · 2024-02-24T11:10:27Z

yes, its still a draft, I assume because its not automatically been removed because the title wasn't prefixed with XXXX-XX-XX.

Swiftb0y · 2024-02-24T11:27:46Z

fixed by manual commit

initial draft

ef22f96

wip wip

ronso0 changed the title ~~initial draft~~ Scrolling Waveforms blog post, initial draft Jan 21, 2024

m0dB changed the title ~~Scrolling Waveforms blog post, initial draft~~ blogpost about improved scrolling waveforms in Mixxx 2.4.0 Jan 21, 2024

typo

0950474

added name to config

54d6b6a

m0dB changed the title ~~blogpost about improved scrolling waveforms in Mixxx 2.4.0~~ Scrolling Waveforms blog post, initial draft Jan 21, 2024

avatar

3d1b208

ronso0 reviewed Jan 21, 2024

View reviewed changes

content/news/2024-01-23-improved-waveforms.md Outdated Show resolved Hide resolved

content/news/2024-01-23-improved-waveforms.md Outdated Show resolved Hide resolved

m0dB and others added 2 commits January 22, 2024 01:01

Update content/news/2024-01-23-improved-waveforms.md

b814e73

Co-authored-by: ronso0 <[email protected]>

Update content/news/2024-01-23-improved-waveforms.md

91b08b9

Co-authored-by: ronso0 <[email protected]>

JoergAtGithub reviewed Jan 25, 2024

View reviewed changes

ronso0 reviewed Jan 26, 2024

View reviewed changes

content/news/2024-01-23-improved-waveforms.md Outdated Show resolved Hide resolved

ronso0 reviewed Jan 26, 2024

View reviewed changes

content/news/2024-01-23-improved-waveforms.md Outdated Show resolved Hide resolved

m0dB and others added 3 commits January 27, 2024 16:39

Update content/news/2024-01-23-improved-waveforms.md

ea0c178

Co-authored-by: ronso0 <[email protected]>

Update content/news/2024-01-23-improved-waveforms.md

77bd1ae

Co-authored-by: ronso0 <[email protected]>

restructured to separate non-technical / technical details, added scr…

583bc84

…eenshots

changes screenshot

64aa113

JoergAtGithub approved these changes Jan 27, 2024

View reviewed changes

JoergAtGithub changed the title ~~Scrolling Waveforms blog post, initial draft~~ Scrolling Waveforms blog post Jan 27, 2024

edits in response to https://mixxx.zulipchat.com/#narrow/stream/24880…

cb19ef6

…2-website/topic/Native.20Englisch.20speaker.20needed.2C.20to.20check.20blog.20post/near/418462984 and for PLL being default on macOS

final tweaks

7c0e292

daschuer approved these changes Feb 20, 2024

View reviewed changes

daschuer reviewed Feb 20, 2024

View reviewed changes

minor changes to PLL paragraph

081acd9

ronso0 approved these changes Feb 20, 2024

View reviewed changes

content/news/2024-01-23-improved-waveforms.md Outdated Show resolved Hide resolved

larger intro paragraph, moved and changes first header

18639e3

JoergAtGithub merged commit 50779f4 into mixxxdj:website Feb 23, 2024
6 checks passed

Holzhaus reviewed Feb 23, 2024

View reviewed changes


		The Mixxx scrolling waveforms are drawn with a number of overlapping layers: The beat grid, the looping-, intro- and outro-ranges, the markers, the end-of-track indication, and the actual waveform. Originally these layers were rendered with a combination of Qt (QPainter) and Legacy OpenGL calls, on the now deprecated QGLWidget. Profiling showed that this combination was a performance bottleneck, particularly on macOS. With the rewrite, all these layers are now using Modern OpenGL, with hardware accelerated GLSL shaders. The different waveform types (Simple, Filtered, HSV, RGB and RGB L/R) all come with a GLSL implementation. In addition to the waveforms, the spinny widgets and VU-meters have been rewritten with the same approach.

		Visually the new waveforms follow the design of the legacy waveforms, with some minor tweaks, note for example the semi-transparently filled triangles pre- and post track. What has been improved is the layout of the markers layers: Overlapping markers (multiple markers at the same beat grid location) which would previously obfuscate each other, are now automatically placed at an increasing / decreasing vertical position.


		## New display synchronization mode

		Finally, a last minute addition is an alternative mode to synchronise the scrolling waveform animation with the display refresh rate, using a so-called phase-locked-loop (PLL). This mechanism attempts to track the actual refresh rate and timing of the display automatically. On particular hardware, the default periodic timer-based approach can result in jitter and frame drops, and the PLL may give better results. The PLL has been made the default on macOS. See [instructions to change the V-Sync mode](https://github.com/mixxxdj/mixxx/wiki/Changing-the-VSync-Mode-for-Scrolling-Waveforms) if you want to try which mode works best for you.


		## Some technical insights

		Mixxx uses the Qt software framework for its user interface. Originally the layers that form the scrolling waveform display were rendered on the now deprecated QGLWidget through a combination of 'QPainter' and Legacy OpenGL function calls. Profiling showed that this combination was a performance bottleneck, particularly on macOS.


		With the rewrite, all the layers mentioned above are now implemented using Modern OpenGL code: All different waveform types, i.e, Simple, Filtered, HSV, RGB and RGB L/R, are now hardware accelarated using GLSL shaders. In addition to the waveforms, the spinny widgets and VU-meters code has been revised with the same approach.

		The deprecated QGLWidget has been replaced by a custom solution using a QOpenGLWindow inside a QWidget using the createWindowContainer() call. Qt also offers QOpenGLWidget to replace QGLWidget, but the QOpenGLWindow solution resulted in better performance and integrated better with the existing source code. This change will also facilitate the migration to Qt 6, planned for Mixxx 2.5.


		One of the major improvements of Mixxx 2.4 is a revision of the scrolling waveform implementation, to achieve smoother animation at a higher frame rate (60 fps), with less frame-drops and lower CPU load.

		## Rewrite

Scrolling Waveforms blog post #314

Scrolling Waveforms blog post #314

Conversation

m0dB commented Jan 21, 2024 • edited by ronso0 Loading

Holzhaus commented Jan 21, 2024

ronso0 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Swiftb0y commented Jan 26, 2024

m0dB commented Jan 27, 2024

JoergAtGithub left a comment

Choose a reason for hiding this comment

m0dB commented Jan 27, 2024

JoergAtGithub commented Jan 28, 2024

m0dB commented Jan 30, 2024

ywwg commented Feb 13, 2024

Swiftb0y commented Feb 13, 2024

m0dB commented Feb 13, 2024

Swiftb0y commented Feb 13, 2024

m0dB commented Feb 19, 2024

JoergAtGithub commented Feb 19, 2024

ronso0 commented Feb 19, 2024

daschuer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JoergAtGithub commented Feb 20, 2024

ywwg commented Feb 21, 2024

ywwg commented Feb 21, 2024

ywwg commented Feb 21, 2024

m0dB commented Feb 22, 2024

ronso0 commented Feb 23, 2024 • edited Loading

m0dB commented Feb 23, 2024

JoergAtGithub commented Feb 23, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Holzhaus commented Feb 24, 2024

JoergAtGithub commented Feb 24, 2024

Swiftb0y commented Feb 24, 2024

Swiftb0y commented Feb 24, 2024

m0dB commented Jan 21, 2024 •

edited by ronso0

Loading

ronso0 commented Feb 23, 2024 •

edited

Loading